feat(www): Convert API pages to MDX #20763
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rted some api docs to MDX, but they still need to be verified. More testing is needed.
…cts data directly to be used within components of hte page, all MDX files have been adjusted. This exposes the headings for translation.
…nted in the root of the file, which is consistent with the other doc files.
…files, not a regexp. Updated mdx to new convention.
…s. Perhaps someday they can be added with the suggested names. Fixed issue where types were not shown on top level items in `node-api-helpers.mdx`. They were a side-effect of how the api jsdoc was written/queried, should they not exist?
tesseralis
commented
Jan 21, 2020
tesseralis
requested review from
freiksenet
and removed request for
freiksenet
|
Will have to deal with the merge conflicts but this makes sense to me. I'd definitely like some input from someone on Core when they're able. |
39 tasks
pieh
reviewed
Feb 10, 2020
pieh
reviewed
Feb 10, 2020
pieh
reviewed
Feb 10, 2020
pieh
reviewed
Feb 10, 2020
pieh
reviewed
Feb 10, 2020
pieh
previously requested changes
Feb 10, 2020
Co-Authored-By: Michal Piechowiak <misiek.piechowiak@gmail.com>
Co-Authored-By: Michal Piechowiak <misiek.piechowiak@gmail.com>
Co-Authored-By: Michal Piechowiak <misiek.piechowiak@gmail.com>
|
@pieh merged in all the changes! Should be straightforward but I'm waiting for my local build to finish to test that everything works out well. |
pieh
approved these changes
Feb 10, 2020
There was a problem hiding this comment.
Awesome!
Thanks @Sever1an for initial work and @tesseralis for finishing it up!
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update of @Sever1an's PR here to bring it up to date with master.
Make all the API pages markdown pages with their own custom template
template-api-markdown. Frontmatter can be used to determine what JSDoc to query, API calls to use, etc.Related Issues
Fixes: #19035